home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / info.n < prev    next >
Text File  |  1994-09-20  |  8KB  |  199 lines
  1.  
  2.  
  3.  
  4. info(n)               Tcl Built-In Commands                   7.0
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      info - Return information about the state of the Tcl  inter-
  12.      preter
  13.  
  14. SYNOPSIS
  15.      info _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  16. _________________________________________________________________
  17.  
  18.  
  19. DESCRIPTION
  20.      This command provides information about various internals of
  21.      the  Tcl  interpreter.   The  legal  _o_p_t_i_o_n's  (which may be
  22.      abbreviated) are:
  23.  
  24.      info args _p_r_o_c_n_a_m_e
  25.           Returns a list containing the names of the arguments to
  26.           procedure  _p_r_o_c_n_a_m_e,  in  order.   _P_r_o_c_n_a_m_e must be the
  27.           name of a Tcl command procedure.
  28.  
  29.      info body _p_r_o_c_n_a_m_e
  30.           Returns the body of procedure _p_r_o_c_n_a_m_e.  _P_r_o_c_n_a_m_e  must
  31.           be the name of a Tcl command procedure.
  32.  
  33.      info cmdcount
  34.           Returns a count of the total number  of  commands  that
  35.           have been invoked in this interpreter.
  36.  
  37.      info commands ?_p_a_t_t_e_r_n?
  38.           If _p_a_t_t_e_r_n isn't specified, returns a list of names  of
  39.           all  the Tcl commands, including both the built-in com-
  40.           mands written in C and the command  procedures  defined
  41.           using  the proc command.  If _p_a_t_t_e_r_n is specified, only
  42.           those names matching _p_a_t_t_e_r_n are returned.  Matching is
  43.           determined using the same rules as for string match.
  44.  
  45.      info complete _c_o_m_m_a_n_d
  46.           Returns 1 if _c_o_m_m_a_n_d is a complete Tcl command  in  the
  47.           sense of having no unclosed quotes, braces, brackets or
  48.           array element names, If the command doesn't  appear  to
  49.           be  complete then 0 is returned.  This command is typi-
  50.           cally used in line-oriented input environments to allow
  51.           users to type in commands that span multiple lines;  if
  52.           the  command  isn't  complete,  the  script  can  delay
  53.           evaluating it until additional lines have been typed to
  54.           complete the command.
  55.  
  56.      info default _p_r_o_c_n_a_m_e _a_r_g _v_a_r_n_a_m_e
  57.           _P_r_o_c_n_a_m_e must be the name of a  Tcl  command  procedure
  58.           and  _a_r_g  must  be the name of an argument to that pro-
  59.           cedure.  If _a_r_g doesn't have a default value  then  the
  60.  
  61.  
  62.  
  63. Tcl                                                             1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. info(n)               Tcl Built-In Commands                   7.0
  71.  
  72.  
  73.  
  74.           command  returns  0.  Otherwise it returns 1 and places
  75.           the default value of _a_r_g into variable _v_a_r_n_a_m_e.
  76.  
  77.      info exists _v_a_r_N_a_m_e
  78.           Returns 1 if the variable named _v_a_r_N_a_m_e exists  in  the
  79.           current context (either as a global or local variable),
  80.           returns 0 otherwise.
  81.  
  82.      info globals ?_p_a_t_t_e_r_n?
  83.           If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  84.           names  of  currently-defined global variables.  If _p_a_t_-
  85.           _t_e_r_n is specified, only those  names  matching  _p_a_t_t_e_r_n
  86.           are  returned.   Matching  is determined using the same
  87.           rules as for string match.
  88.  
  89.      info level ?_n_u_m_b_e_r?
  90.           If _n_u_m_b_e_r is not  specified,  this  command  returns  a
  91.           number  giving  the  stack  level  of the invoking pro-
  92.           cedure, or 0 if the command is  invoked  at  top-level.
  93.           If  _n_u_m_b_e_r is specified, then the result is a list con-
  94.           sisting of the name and  arguments  for  the  procedure
  95.           call  at level _n_u_m_b_e_r on the stack.  If _n_u_m_b_e_r is posi-
  96.           tive then it selects a particular stack level (1 refers
  97.           to the top-most active procedure, 2 to the procedure it
  98.           called, and so on); otherwise it gives a level relative
  99.           to  the  current  level  (0  refers to the current pro-
  100.           cedure, -1 to its caller, and so on).  See the  uplevel
  101.           command for more information on what stack levels mean.
  102.  
  103.      info library
  104.           Returns the name of  the  library  directory  in  which
  105.           standard Tcl scripts are stored.  The default value for
  106.           the library is compiled into Tcl, but it may  be  over-
  107.           ridden by setting the TCL_LIBRARY environment variable.
  108.           If there is no TCL_LIBRARY variable and no  compiled-in
  109.           value  then  and  error  is generated.  See the library
  110.           manual entry for details of the facilities provided  by
  111.           the Tcl script library.  Normally each application will
  112.           have its own  application-specific  script  library  in
  113.           addition  to  the  Tcl  script library;  I suggest that
  114.           each application set a global variable with a name like
  115.           $_a_p_p_library  (where  _a_p_p is the application's name) to
  116.           hold the location of that application's library  direc-
  117.           tory.
  118.  
  119.      info locals ?_p_a_t_t_e_r_n?
  120.           If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  121.           names  of  currently-defined local variables, including
  122.           arguments to the current procedure, if any.   Variables
  123.           defined  with the global and upvar commands will not be
  124.           returned.  If _p_a_t_t_e_r_n is specified,  only  those  names
  125.           matching  _p_a_t_t_e_r_n are returned.  Matching is determined
  126.  
  127.  
  128.  
  129. Tcl                                                             2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. info(n)               Tcl Built-In Commands                   7.0
  137.  
  138.  
  139.  
  140.           using the same rules as for string match.
  141.  
  142.      info patchlevel
  143.           Returns a decimal  integer  giving  the  current  patch  |
  144.           level for Tcl.  The patch level is incremented for each  |
  145.           new release or patch, and  it  uniquely  identifies  an  |
  146.           official version of Tcl.
  147.  
  148.      info procs ?_p_a_t_t_e_r_n?
  149.           If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  150.           names  of Tcl command procedures.  If _p_a_t_t_e_r_n is speci-
  151.           fied, only those names matching _p_a_t_t_e_r_n  are  returned.
  152.           Matching  is  determined  using  the  same rules as for
  153.           string match.
  154.  
  155.      info script
  156.           If a Tcl script file is currently being evaluated (i.e.
  157.           there  is  a call to Tcl_EvalFile active or there is an
  158.           active invocation of the  source  command),  then  this
  159.           command  returns  the  name of the innermost file being
  160.           processed.  Otherwise  the  command  returns  an  empty
  161.           string.
  162.  
  163.      info tclversion
  164.           Returns the version number for this version of  Tcl  in
  165.           the  form  _x._y,  where  changes  to  _x  represent major
  166.           changes with probable incompatibilities and changes  to
  167.           _y  represent  small  enhancements  and  bug  fixes that
  168.           retain backward compatibility.
  169.  
  170.      info vars ?_p_a_t_t_e_r_n?
  171.           If _p_a_t_t_e_r_n isn't specified, returns a list of  all  the
  172.           names  of  currently-visible  variables, including both
  173.           locals and currently-visible globals.   If  _p_a_t_t_e_r_n  is
  174.           specified,   only  those  names  matching  _p_a_t_t_e_r_n  are
  175.           returned.  Matching is determined using the same  rules
  176.           as for string match.
  177.  
  178.  
  179. KEYWORDS
  180.      command, information, interpreter, level,  procedure,  vari-
  181.      able
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Tcl                                                             3
  196.  
  197.  
  198.  
  199.